home *** CD-ROM | disk | FTP | other *** search
/ QRZ! Ham Radio 12 / QRZ Ham Radio Callsign Database - Volume 12.iso / qrzhelp.txt < prev    next >
Text File  |  1998-11-11  |  9KB  |  219 lines
  1.  
  2. QRZ Command Processor Help File (Version 1.0)
  3.  
  4. At the main QRZ! prompt, the following commands are valid:
  5.  
  6.      <callsign> Looks up the callsign 
  7.      N .........Searches the Name database.
  8.      S..........Searches the City/State database.
  9.      Z..........Searches the Zip Code database.
  10.      M..........Takes you to the setup menu (printing, files, etc.).
  11.      H or ?.....Gets you this help.   
  12.      Q..........Exits the program.
  13.  
  14.  
  15. Command Detail
  16.  
  17. The QRZ command processor expects that the user will input either a
  18. callsign pattern or a command.  All commands are single letter.  Any
  19. group of two or more letters in a row is considered a callsign lookup
  20. command.  For example, if you type 'abc' at the command prompt, the
  21. program will look up all callsigns which end in the letters 'ABC'.
  22. The entire database is upper case and all user input is converted
  23. to upper case so all commands and patterns are case insensitive.
  24.  
  25. <callsign>  When a multiple letter pattern is input, the program uses
  26.    it to find a matching callsign or callsigns.  The search engine does
  27.    callsign suffix matching, that is, the letters which follow the
  28.    number (and the number itself) in a callsign.  The program does not
  29.    do prefix (e.g. WB1*) matching.
  30.  
  31. N  This command performs lookups in the person names database.
  32.    In a multi-parameter input line, the command may be given as 'n
  33.    last first' where 'last' is the person's last name and 'first' is
  34.    their first or surname.  The name pattern search ignores middle
  35.    initials.  You can use the star '*' character to mean all FIRST
  36.    names in the database.  The '*' character may be used with last
  37.    names after the first letter(s).  For example, the command 
  38.    'n s* *) will list all people whose last name begins with an 's'.
  39.    The first name part (if given) is always considered to be first*
  40.    so if you type 'n smith fred' you'll get both Fred Smith and 
  41.    Fredrick Smith.  .  If you type only 'N' by itself, the program
  42.    will prompt you for the last and then the first name to look for.
  43.    Arguments which contain spaces (e.g. "Le May" or "Jean Luc")
  44.    must be enclosed in double quotes.
  45.  
  46. S  This command performs lookups in the City/State database. The
  47.    command operates similar to the 'N' command in that '*' may be used
  48.    to with the city part.  If you do not supply the city and state
  49.    parameters on the command line, the program will prompt you for
  50.    input.  City names which contain spaces must be quoted within
  51.    double quotes (e.g. 's  mo "saint louis"' returns all hams
  52.    living in Saint Louis, Missouri).
  53.  
  54. Z  This command performs lookups in the Zip Code database.  The 'Z'
  55.    command expects a single zipcode to follow it, as in 'z 90210'.  If
  56.    you do not supply the zipcode after the 'Z', the program will prompt
  57.    you for it.
  58.  
  59. M  The 'M' commands are used to access the Setup Menu.  The setup
  60.    menu allows you to control such things as turning printers on and
  61.    off, sending output to a file, turning screen output on or off, and
  62.    a selection of data output formats.  There are 11 classes of 'M'
  63.    commands, which can be seen by simply typing 'M'.  'M' commands can
  64.    be stacked on a command line.  Take for example the command:
  65.  
  66.    m 2 d:\test m 4 m 3 s * nv
  67.  
  68.    This is a compound command which says
  69.         
  70.         m 2 d:\test   <- write output to file called d:\test
  71.         m 4           <- select mailing label format
  72.         m 3           <- turn off screen output
  73.         s * nv        <- lookup all cities in Nevada
  74.  
  75.  
  76.    Typing 'M' with no arguments invokes the interactive setup menu.
  77.    The default setup menu has the following status display:
  78.  
  79.          1)  Output to Printer.........OFF
  80.          2)  Output to File............OFF
  81.          3)  Output to Screen..........ON
  82.          4)  Mailing Label Format......OFF
  83.          5)  Raw Record Format.........OFF
  84.          6)  Book Format...............OFF
  85.          7)  Screen Format ............ON
  86.          8)  Pause on Full Screen......ON
  87.          9)  Records Per Page..........6
  88.  
  89.       Enter item # to CHANGE or Q to exit -> 
  90.  
  91.  
  92. The M Commands
  93.  
  94. Output Directors - selects output destination(s).  Any (or none)
  95.     of the following destinations may be simultaneously selected.
  96.  
  97.    M 1 - Send Output to Printer.  On/Off Toggle.  Sends all output to
  98.          The printer.  Screen output is suspended (may be turned back
  99.          on with M 3).  M 1 turns the printer on or off each time it is
  100.          invoked.
  101.  
  102.    M 2 [filename] - Send Output to File.  On/Off Toggle.  Sends all
  103.         output to the file <filename>.  Screen output is suspended (may
  104.         be turned back on with M 3)
  105.  
  106.    M 3 - Send Output to Screen. On/Off Toggle.  Used in conjunction
  107.          with commands M 1 and M 2 above to force screen output ON.
  108.  
  109. Format Selectors - Any one of M 4 thru M 8 may be selected at any time.
  110.  
  111.    M 4 - Mailing Label Format.  Records are output in a format suitable
  112.          for printing on mailing labels.  Records are output in a three
  113.          line format with a leading and trailing blank line (5 lines
  114.          per record).
  115.  
  116.    M 5 - Raw Record Format. -  Records are output as a single line of
  117.          text with comma separated fields (see the file qrz_tech.txt
  118.          for field descriptions.
  119.  
  120.    M 6 - Book Format - Records are output in a one-line format similar
  121.          to that found in printed callsign books.  Calls are output
  122.          aligned by their call area number.
  123.  
  124.    M 7 - Screen Format - Default.  Records are output in the default
  125.          three line screen format.  The [o] (camera) symbol means
  126.          that a .GIF file exists for this callsign in D:\callbk\gifs
  127.  
  128. Utility Commands
  129.  
  130.    M 8 - Pause on Full Screen.  Toggle.  Directs the program wether
  131.          to pause output on each full screen of data.  ON by default
  132.          except when called from the non interactive command line.
  133.  
  134.    M 9 [num] - Records Per Page.  Used to reset the number or records
  135.          shown before the screen pauses.  Set by default when any of
  136.          M 4 thru M 7 are selected.
  137.  
  138.    M 0 - Reset to Defaults.  Used to reset all M parameters to their
  139.          initial values.  Closes any files (from M 2) which may be
  140.          open.  Resets to M 3, M 7, and M 8 ON.
  141.  
  142.    M S - M Status.  Displays the status of each of the M parameters.
  143.  
  144.  
  145. Compound Commands
  146.  
  147.    Any of the commands above including the M commands may be given
  148.    as multiple comands on the same line.  For example, it is possible
  149.    to open a named file, make a format selection, select a class of
  150.    records and close the file with a single line like:
  151.  
  152.    M 2 smiths.txt m 4 n smith "*" M 2 
  153.  
  154.    This command opens a file called smiths.txt, chooses the mailing
  155.    label output format, selects all records whose last name is 'Smith'
  156.    and then closes the file.
  157.  
  158.  
  159. Command Line Invocation
  160.  
  161.    Commands and arguments may be passed to the qrzcom program directly
  162.    from the command line.  For example, the compound command shown
  163.    above could be executed directly from the command line as:
  164.  
  165.    C:\> QRZCOM M 2 smiths.txt m 4 n smith "*" M 2
  166.    C:\>
  167.  
  168.  
  169. Using with Pipes
  170.  
  171.    When piping the output of another program into qrzcom, use the
  172.    '-' character to indicate that input is coming from a pipe.  When
  173.    the '-' is used, qrzcom will execute silently.
  174.  
  175.    C:\> TYPE FRIENDS.TXT | QRZCOM -
  176.  
  177.         <output listing...>
  178.    C:\>
  179.  
  180.  
  181. The QRZ.INI File
  182.  
  183.    This file, if present in the user's current path (or QRZPATH), may
  184.    contain a list of commands to execute upon startup.  There is no
  185.    limit to the number of commands this file may contain.  If this file
  186.    ends with the Q command, the program will exit rather than returning
  187.    to the command mode.
  188.  
  189.  
  190. Environment Variables
  191.  
  192.    QRZPATH  If set, is used to indicate the pathname to the directory
  193.       containing the QRZ! data files.  Normally x:\callbk is automatically
  194.       chosen by the program on startup.
  195.  
  196.    QRZDRV   If set, indicates the drive letter (DOS ONLY) to use with
  197.       QRZPATH above.
  198.  
  199.  
  200. Program Availabilty
  201.  
  202.    The program is normally available for MSDOS machines.  A version for
  203.    UNIX is also available which contains exactly the same features.
  204.  
  205.  
  206. Shareware
  207.  
  208.    This program may be freely copied for the exclusive use with the
  209.    QRZ! Ham Radio CDROM.
  210.  
  211.  
  212. Comments
  213.  
  214.    Send your comments to Fred Lloyd, AA7BQ   flloyd@qrz.com
  215.  
  216. ------------------- End of Help ------------------------
  217.  
  218. 
  219.